<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>LuaApp项目接口文档</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>LuaApp</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Methods">Methods</a></li>
</ul>


<h2>Classes</h2>
<ul class="nowrap">
  <li><a href="../classes/ActivityIndicatorView.html">ActivityIndicatorView</a></li>
  <li><a href="../classes/AlertView.html">AlertView</a></li>
  <li><a href="../classes/Application.html">Application</a></li>
  <li><strong>AudioEngine</strong></li>
  <li><a href="../classes/Button.html">Button</a></li>
  <li><a href="../classes/CaptureView.html">CaptureView</a></li>
  <li><a href="../classes/CheckBox.html">CheckBox</a></li>
  <li><a href="../classes/ClippingView.html">ClippingView</a></li>
  <li><a href="../classes/Control.html">Control</a></li>
  <li><a href="../classes/DatePickerView.html">DatePickerView</a></li>
  <li><a href="../classes/Device.html">Device</a></li>
  <li><a href="../classes/DownloadManager.html">DownloadManager</a></li>
  <li><a href="../classes/DrawView.html">DrawView</a></li>
  <li><a href="../classes/DrawerController.html">DrawerController</a></li>
  <li><a href="../classes/FileUtils.html">FileUtils</a></li>
  <li><a href="../classes/GifView.html">GifView</a></li>
  <li><a href="../classes/HttpClient.html">HttpClient</a></li>
  <li><a href="../classes/HttpRequest.html">HttpRequest</a></li>
  <li><a href="../classes/Image.html">Image</a></li>
  <li><a href="../classes/ImageView.html">ImageView</a></li>
  <li><a href="../classes/Label.html">Label</a></li>
  <li><a href="../classes/LinearView.html">LinearView</a></li>
  <li><a href="../classes/ListView.html">ListView</a></li>
  <li><a href="../classes/ListViewCell.html">ListViewCell</a></li>
  <li><a href="../classes/NavController.html">NavController</a></li>
  <li><a href="../classes/Progress.html">Progress</a></li>
  <li><a href="../classes/Slider.html">Slider</a></li>
  <li><a href="../classes/Stepper.html">Stepper</a></li>
  <li><a href="../classes/Switch.html">Switch</a></li>
  <li><a href="../classes/TabBarController.html">TabBarController</a></li>
  <li><a href="../classes/TextField.html">TextField</a></li>
  <li><a href="../classes/TextView.html">TextView</a></li>
  <li><a href="../classes/UILoader.html">UILoader</a></li>
  <li><a href="../classes/View.html">View</a></li>
  <li><a href="../classes/ViewController.html">ViewController</a></li>
  <li><a href="../classes/WebView.html">WebView</a></li>
  <li><a href="../classes/Window.html">Window</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/Animation.html">Animation</a></li>
  <li><a href="../modules/class.html">class</a></li>
  <li><a href="../modules/constants.html">constants</a></li>
  <li><a href="../modules/crossapp.html">crossapp</a></li>
  <li><a href="../modules/cjson.html">cjson</a></li>
  <li><a href="../modules/mobdebug.html">mobdebug</a></li>
</ul>
<h2>Topics</h2>
<ul class="">
  <li><a href="../topics/readme.md.html">readme</a></li>
  <li><a href="../topics/layout.md.html">layout</a></li>
</ul>

</div>

<div id="content">

<h1>Class <code>AudioEngine</code></h1>
<p>音频播放类
单例类，使用ca.sharedAudioEngine() 获取</p>
<p>

</p>


<h2><a href="#Methods">Methods</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:preloadBackgroundMusic">AudioEngine:preloadBackgroundMusic (string)</a></td>
	<td class="summary">预加载背景音乐</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:playBackgroundMusic">AudioEngine:playBackgroundMusic (string, bool)</a></td>
	<td class="summary">播放背景音乐</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:stopBackgroundMusic">AudioEngine:stopBackgroundMusic (bool)</a></td>
	<td class="summary">停止播放背景音乐</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:pauseBackgroundMusic">AudioEngine:pauseBackgroundMusic ()</a></td>
	<td class="summary">暂停播放背景音乐</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:resumeBackgroundMusic">AudioEngine:resumeBackgroundMusic ()</a></td>
	<td class="summary">恢复播放背景音乐</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:rewindBackgroundMusic">AudioEngine:rewindBackgroundMusic ()</a></td>
	<td class="summary">重新播放背景音乐</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:willPlayBackgroundMusic">AudioEngine:willPlayBackgroundMusic ()</a></td>
	<td class="summary">将要播放背景音乐</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:isBackgroundMusicPlaying">AudioEngine:isBackgroundMusicPlaying ()</a></td>
	<td class="summary">是否正在播放背景音乐</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:getBackgroundMusicVolume">AudioEngine:getBackgroundMusicVolume ()</a></td>
	<td class="summary">获取背景音乐音量</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:setBackgroundMusicVolume">AudioEngine:setBackgroundMusicVolume (volume)</a></td>
	<td class="summary">设置背景音乐音量</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:getEffectsVolume">AudioEngine:getEffectsVolume ()</a></td>
	<td class="summary">获取音效音量</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:setEffectsVolume">AudioEngine:setEffectsVolume (volume)</a></td>
	<td class="summary">设置音效音量</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:playEffect">AudioEngine:playEffect (audio_file, is_loop)</a></td>
	<td class="summary">播放音效</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:pauseEffect">AudioEngine:pauseEffect (sound_id)</a></td>
	<td class="summary">暂停音效</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:pauseAllEffects">AudioEngine:pauseAllEffects ()</a></td>
	<td class="summary">暂停所有音效</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:resumeEffect">AudioEngine:resumeEffect (sound_id)</a></td>
	<td class="summary">恢复音效</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:resumeAllEffects">AudioEngine:resumeAllEffects ()</a></td>
	<td class="summary">恢复所有音效</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:stopEffect">AudioEngine:stopEffect (sound_id)</a></td>
	<td class="summary">停止音效</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:stopAllEffects">AudioEngine:stopAllEffects ()</a></td>
	<td class="summary">停止所有音效</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:preloadEffect">AudioEngine:preloadEffect (audio_file)</a></td>
	<td class="summary">预加载音效</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#AudioEngine:unloadEffect">AudioEngine:unloadEffect (audio_file)</a></td>
	<td class="summary">卸载音效</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Methods"></a>Methods</h2>

    <dl class="function">
    <dt>
    <a name = "AudioEngine:preloadBackgroundMusic"></a>
    <strong>AudioEngine:preloadBackgroundMusic (string)</strong>
    </dt>
    <dd>
    预加载背景音乐


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">string</span>
         audio_file
        </li>
    </ul>





</dd>
    <dt>
    <a name = "AudioEngine:playBackgroundMusic"></a>
    <strong>AudioEngine:playBackgroundMusic (string, bool)</strong>
    </dt>
    <dd>
    播放背景音乐


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">string</span>
         audio_file
        </li>
        <li><span class="parameter">bool</span>
         bloop
        </li>
    </ul>





</dd>
    <dt>
    <a name = "AudioEngine:stopBackgroundMusic"></a>
    <strong>AudioEngine:stopBackgroundMusic (bool)</strong>
    </dt>
    <dd>
    停止播放背景音乐


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">bool</span>
         bReleaseData
        </li>
    </ul>





</dd>
    <dt>
    <a name = "AudioEngine:pauseBackgroundMusic"></a>
    <strong>AudioEngine:pauseBackgroundMusic ()</strong>
    </dt>
    <dd>
    暂停播放背景音乐







</dd>
    <dt>
    <a name = "AudioEngine:resumeBackgroundMusic"></a>
    <strong>AudioEngine:resumeBackgroundMusic ()</strong>
    </dt>
    <dd>
    恢复播放背景音乐







</dd>
    <dt>
    <a name = "AudioEngine:rewindBackgroundMusic"></a>
    <strong>AudioEngine:rewindBackgroundMusic ()</strong>
    </dt>
    <dd>
    重新播放背景音乐







</dd>
    <dt>
    <a name = "AudioEngine:willPlayBackgroundMusic"></a>
    <strong>AudioEngine:willPlayBackgroundMusic ()</strong>
    </dt>
    <dd>
    将要播放背景音乐







</dd>
    <dt>
    <a name = "AudioEngine:isBackgroundMusicPlaying"></a>
    <strong>AudioEngine:isBackgroundMusicPlaying ()</strong>
    </dt>
    <dd>
    是否正在播放背景音乐



    <h3>Returns:</h3>
    <ol>

        bPlay
    </ol>




</dd>
    <dt>
    <a name = "AudioEngine:getBackgroundMusicVolume"></a>
    <strong>AudioEngine:getBackgroundMusicVolume ()</strong>
    </dt>
    <dd>
    获取背景音乐音量



    <h3>Returns:</h3>
    <ol>

        volume
    </ol>




</dd>
    <dt>
    <a name = "AudioEngine:setBackgroundMusicVolume"></a>
    <strong>AudioEngine:setBackgroundMusicVolume (volume)</strong>
    </dt>
    <dd>
    设置背景音乐音量


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">volume</span>



        </li>
    </ul>





</dd>
    <dt>
    <a name = "AudioEngine:getEffectsVolume"></a>
    <strong>AudioEngine:getEffectsVolume ()</strong>
    </dt>
    <dd>
    获取音效音量



    <h3>Returns:</h3>
    <ol>

        volume
    </ol>




</dd>
    <dt>
    <a name = "AudioEngine:setEffectsVolume"></a>
    <strong>AudioEngine:setEffectsVolume (volume)</strong>
    </dt>
    <dd>
    设置音效音量


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">volume</span>



        </li>
    </ul>





</dd>
    <dt>
    <a name = "AudioEngine:playEffect"></a>
    <strong>AudioEngine:playEffect (audio_file, is_loop)</strong>
    </dt>
    <dd>
    播放音效


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">audio_file</span>



        </li>
        <li><span class="parameter">is_loop</span>



        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        sound_id
    </ol>




</dd>
    <dt>
    <a name = "AudioEngine:pauseEffect"></a>
    <strong>AudioEngine:pauseEffect (sound_id)</strong>
    </dt>
    <dd>
    暂停音效


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">sound_id</span>



        </li>
    </ul>





</dd>
    <dt>
    <a name = "AudioEngine:pauseAllEffects"></a>
    <strong>AudioEngine:pauseAllEffects ()</strong>
    </dt>
    <dd>
    暂停所有音效







</dd>
    <dt>
    <a name = "AudioEngine:resumeEffect"></a>
    <strong>AudioEngine:resumeEffect (sound_id)</strong>
    </dt>
    <dd>
    恢复音效


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">sound_id</span>



        </li>
    </ul>





</dd>
    <dt>
    <a name = "AudioEngine:resumeAllEffects"></a>
    <strong>AudioEngine:resumeAllEffects ()</strong>
    </dt>
    <dd>
    恢复所有音效







</dd>
    <dt>
    <a name = "AudioEngine:stopEffect"></a>
    <strong>AudioEngine:stopEffect (sound_id)</strong>
    </dt>
    <dd>
    停止音效


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">sound_id</span>



        </li>
    </ul>





</dd>
    <dt>
    <a name = "AudioEngine:stopAllEffects"></a>
    <strong>AudioEngine:stopAllEffects ()</strong>
    </dt>
    <dd>
    停止所有音效







</dd>
    <dt>
    <a name = "AudioEngine:preloadEffect"></a>
    <strong>AudioEngine:preloadEffect (audio_file)</strong>
    </dt>
    <dd>
    预加载音效


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">audio_file</span>



        </li>
    </ul>





</dd>
    <dt>
    <a name = "AudioEngine:unloadEffect"></a>
    <strong>AudioEngine:unloadEffect (audio_file)</strong>
    </dt>
    <dd>
    卸载音效


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">audio_file</span>



        </li>
    </ul>





</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2017-04-25 21:28:27 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
